docs(snapshots): Add agentic workflow page#17939
Merged
cameroncooke merged 2 commits intoJun 2, 2026
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
1 Skipped Deployment
|
Add a Snapshots child page that explains how to use Sentry MCP for agent-assisted snapshot investigation. Cover setup, Preprod Snapshots tool selection, snapshot URL handling, primitive snapshot tools, and when to use CLI workflows instead. Co-Authored-By: Claude Code Opus <noreply@example.com>
cameroncooke
force-pushed
the
cameroncooke/docs/snapshots-agentic-workflow
branch
from
59371a5 to
2c71066
Compare
mtopo27
reviewed
Jun 1, 2026
mtopo27
approved these changes
Jun 1, 2026
Add note that while the Sentry MCP is optimized for agentic workflows, users can also fetch snapshot data via the REST API and expose scripts to agents. Co-Authored-By: Claude <noreply@anthropic.com> Co-authored-by: Cameron Cooke <web@cameroncooke.com>
![sentry[bot]](https://avatars.githubusercontent.com/in/12637?s=60&v=4){kind=small}
| <Alert level="info"> | ||
| The Sentry MCP has been optimized to retrieve Snapshot results for agentic | ||
| workflows. If you'd like, you can also fetch the data via the [REST | ||
| API](/api/snapshots/) and expose scripts to agents. |
Contributor
There was a problem hiding this comment.
Bug: The link to the REST API documentation for snapshots at /api/snapshots/ is broken because the target page does not exist.
Severity: LOW
Suggested Fix
Verify the correct path for the Snapshots API documentation. If the page exists at a different URL, update the link's href attribute. If the documentation page does not exist, either remove the link or create the missing documentation page.
Prompt for AI Agent
Review the code at the location below. A potential bug has been identified by an AI
agent. Verify if this is a real issue. If it is, propose a fix; if not, explain why it's
not valid.
Location: docs/product/snapshots/agentic-workflow/index.mdx#L18
Potential issue: The documentation file
`docs/product/snapshots/agentic-workflow/index.mdx` contains a markdown link to
`[API](/api/snapshots/)`. However, the target path `/api/snapshots/` does not correspond
to any existing file or redirect rule within the documentation site. As a result, any
user clicking this link will encounter a 404 'Not Found' error. This creates a broken
cross-reference in the documentation, degrading the user experience for those trying to
find the API documentation for snapshots.
Did we get this right? 👍 / 👎 to inform future reviews.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Adds a new Snapshots documentation page, Agentic Workflow, covering how to use Sentry's MCP server to investigate snapshot results with an AI coding assistant (Claude Code, Cursor, VS Code, and others) instead of clicking through the Sentry UI or downloading images by hand.
get_sentry_resourceversus the advanced tools it unlocks (get_snapshot,get_snapshot_image,get_latest_base_snapshot), plus the context-window tradeoffsentry-cliand Local Testing for local download and diff workflowsThe page sits in the Snapshots section (
sidebar_order: 30) and is gated behind the Early Adopter include. Tool names, parameters, and the example responses were verified against the live Sentry MCP server.IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes: